Appliance Recovery Restore Job RestoreRequest

Appliance Recovery Restore Job RestoreRequest
Appliance Recovery Restore Job RestoreRequest

Appliance Recovery Restore Job RestoreRequest schema Structure representing requested restore piece

JSON Example
{
    "parts": [
        "string"
    ],
    "backup_password": "string",
    "location_type": "string",
    "location": "string",
    "location_user": "string",
    "location_password": "string",
    "sso_admin_user_name": "string",
    "sso_admin_user_password": "string",
    "ignore_warnings": false
}
array of string
parts
Optional

List of standalone parts to restore. Only parts with the Appliance Recovery Backup Parts Part.standalone flag set to true can be included.

This property was added in vSphere API 8.0.3.0.

If missing or null entire VCSA will be restored.

string As password As password
backup_password
Optional

a password for a backup piece

backupPassword If no password then the piece will not be decrypted

string
location_type
Required

a type of location

For more information see: Appliance Recovery Restore Job LocationType.

string
location
Required

path or url

string
location_user
Optional

username for location

locationUser User name for this location if login is required.

string As password As password
location_password
Optional

password for location

locationPassword Password for the specified user if login is required at this location.

string
sso_admin_user_name
Optional

Administrators Username for SSO.

This property was added in vSphere API 6.7.

If missing or null SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.

string As password As password
sso_admin_user_password
Optional

The password for SSO admin user.

This property was added in vSphere API 6.7.

If missing or null SSO authentication will not be used. If the vCenter Server is a management node or an embedded node, authentication is required.

boolean
ignore_warnings
Optional

The flag to ignore warnings during restore

This property was added in vSphere API 6.7.

If missing or null, validation warnings will fail the restore operation

Parameter To